Skip to content

docs(vertexai): remove HTML <code> tags #8900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 15, 2025
Merged

docs(vertexai): remove HTML <code> tags #8900

merged 1 commit into from
Apr 15, 2025

Conversation

dlarocque
Copy link
Contributor

We wrap links that reference public APIs with <code> tags so that they can be rendered as code in devsite. Unfortunately, VSCode's hover feature can not render these links at all.

Since there are no other alternatives for creating code-formatted links, we should remove the problematic HTML <code> tags. Having reference documentation rendered correctly in VSCode is critical.

With HTML <code> tag:

/**
 * Returns a <code>{@link VertexAI}</code> instance for the given app.
 *
 * @public
 *
 * @param app - The {@link @firebase/app#FirebaseApp} to use.
 */
image

Without HTML <code> tag:

/**
 * Returns a {@link VertexAI} instance for the given app.
 *
 * @public
 *
 * @param app - The {@link @firebase/app#FirebaseApp} to use.
 */
image

@dlarocque
docs(vertexai): remove HTML <code> tags
efe813e 
We wrap links that reference public APIs with `<code>` tags so that they
can be rendered as code in devsite. Unfortunately, VSCode's hover
feature can not render these links at all.

Since there are no other alternatives for creating code-formatted links,
we should remove the problematic HTML `<code>` tags.
@dlarocque dlarocque requested review from a team as code owners April 7, 2025 14:06
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Apr 7, 2025

⚠️ No Changeset found

Latest commit: efe813e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 7, 2025

Vertex AI Mock Responses Check ⚠️

A newer major version of the mock responses for Vertex AI unit tests is available. update_vertexai_responses.sh should be updated to clone the latest version of the responses: v8.0

@google-oss-bot
Copy link
Contributor

Size Report 1

Affected Products

No changes between base commit (1df3d26) and merge commit (51f6a12).

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/LEt0p43rgf.html

@google-oss-bot
Copy link
Contributor

Size Analysis Report 1

Affected Products

No changes between base commit (1df3d26) and merge commit (51f6a12).

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/2G1mDOkmzf.html

@dlarocque dlarocque merged commit 8bb66c2 into main Apr 15, 2025
35 of 37 checks passed
@dlarocque dlarocque deleted the dl/refdoc-code-tags branch April 15, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hsubox76 hsubox76 hsubox76 approved these changes

@rachelsaunders rachelsaunders rachelsaunders approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dlarocque @google-oss-bot @hsubox76 @rachelsaunders